Adapter Tasks

Previously, adapter tasks were exposed to Workflow Builder (WFB) and Workflow Engine (WFE) as unique tasks per adapter instance. With workflow_builder v4.0.0, this has changed to generic adapter tasks that require the user to provide the adapter instance (id). A general summary of this change and how to update the workflow.json is provided below.

Note: This change also caused major version changes in app-workflow_engine (v4 → v5) and app-task_worker (v2 → v3).

Workflow Builder AdapterInstance(id)

Adapter methods are exposed in WFB and WFE as automatic tasks. Adapter tasks work the same as any other automatic task. The user must provide an adapter id, which is the instance of the adapter the method will run against.

1. Select the Referene variable in WFB to open a dropdown list of instance ids in the system.
2. Click EDIT to enable manual input (for unknown adapter instance ids).

Update Workflow JSON for Adapter Tasks (Workflow 3.2.11 → 4.0.0)

Use the following steps to edit/update the JSON file for workflows built with adapter tasks prior to workflow_builder 4.0.0 .

1. Find the adapter task in the target window JSON.

2. Add the property locationType and set it to the adapter type. The adapter type name can be found in IAP under Settings > Adapters > AdapterType.

   "ab12" : {
       "locationType" : "NSO",
       "name": "getDevices",
       ...
   }

3. Add an incoming variable adapter_id and set to a string value of the adapter instance id.

   "variables" : {
       "incoming" : {
           "adapter_id" : "My Local NSO",
           "deviceInfo" : "$var.job.deviceInfo",
           ...
       }
   }

4. Change the app and displayName task properties from the instance id to the adapter type.

   "ab12" : {
       "locationType" : "NSO",
       "name" : "getDevices",
       "app" : "NSO",
       "displayName" : "NSO",
       ...
   }